package com.xkcoding.swagger.beauty.config;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

//
//    1、按照swagger的规范，特别是泛型，需要在Controller返回值中明确标出具体对象类型。
//    泛型对象在生成set方法的时候，参数是否是泛型，有些编辑器会默认Object，导致swaggerui展示不出来字段信息。
//    2、如果使用shiro，springsecurity等权限框架，需要放开/v2/**,/swagger-resources/**, /webjars/** 的swagger请求地址，否则被拦截后swaggerui依然显示不了。

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    //通过enable变量控制生产环境（值为false）和测试环境（值为true）切换。
    @Value("${swagger2.enable}")
    private boolean enable;

    @Bean
    public Docket apis() {
        return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.xkcoding.swagger.beauty"))
            .build()
            .enable(enable);

    }

    /**
     * Author:
     * Date: 2019/9/4 16:27
     * Desc: api文档说明
     *
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
            .title("我的系统接口文档")
            .description("用户模块")
            .contact(new Contact("Allen", "http://allen", "allen@qq.com"))
            .version("1.0.0-SNAPSHOT")
            .build();
    }
}
